#ifndef _WX_HELPWND_H_
#define _WX_HELPWND_H_

#include "wx/defs.h"

#if wxUSE_WXHTML_HELP

#include "wx/helpbase.h"
#include "wx/html/helpdata.h"
#include "wx/window.h"
#include "wx/frame.h"
#include "wx/config.h"
#include "wx/splitter.h"
#include "wx/notebook.h"
#include "wx/listbox.h"
#include "wx/choice.h"
#include "wx/combobox.h"
#include "wx/checkbox.h"
#include "wx/stattext.h"
#include "wx/html/htmlwin.h"
#include "wx/html/htmprint.h"

class wxButton;
class wxTextCtrl;
class wxTreeEvent;
class wxTreeCtrl;

// style flags for the Help Frame
#define wxHF_TOOLBAR                0x0001
#define wxHF_CONTENTS               0x0002
#define wxHF_INDEX                  0x0004
#define wxHF_SEARCH                 0x0008
#define wxHF_BOOKMARKS              0x0010
#define wxHF_OPEN_FILES             0x0020
#define wxHF_PRINT                  0x0040
#define wxHF_FLAT_TOOLBAR           0x0080
#define wxHF_MERGE_BOOKS            0x0100
#define wxHF_ICONS_BOOK             0x0200
#define wxHF_ICONS_BOOK_CHAPTER     0x0400
#define wxHF_ICONS_FOLDER           0x0000 // this is 0 since it is default
#define wxHF_DEFAULT_STYLE          (wxHF_TOOLBAR | wxHF_CONTENTS | \
                                     wxHF_INDEX | wxHF_SEARCH | \
                                     wxHF_BOOKMARKS | wxHF_PRINT)
//compatibility:
#define wxHF_OPENFILES               wxHF_OPEN_FILES
#define wxHF_FLATTOOLBAR             wxHF_FLAT_TOOLBAR
#define wxHF_DEFAULTSTYLE            wxHF_DEFAULT_STYLE

struct wxHtmlHelpFrameCfg {
  int x, y, w, h;
  long sashpos;
  bool navig_on;
};

struct wxHtmlHelpMergedIndexItem;
class wxHtmlHelpMergedIndex;

class wxHelpControllerBase;
class wxHtmlHelpController;

class wxHtmlHelpWindow : public wxWindow {
    DECLARE_DYNAMIC_CLASS( wxHtmlHelpWindow )

  public:
    wxHtmlHelpWindow( wxHtmlHelpData* data = NULL ) { Init( data ); }
    wxHtmlHelpWindow( wxWindow* parent, wxWindowID wxWindowID,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      int style = wxTAB_TRAVERSAL | wxNO_BORDER,
                      int helpStyle = wxHF_DEFAULT_STYLE,
                      wxHtmlHelpData* data = NULL );
    bool Create( wxWindow* parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 int style = wxTAB_TRAVERSAL | wxNO_BORDER,
                 int helpStyle = wxHF_DEFAULT_STYLE );
    virtual ~wxHtmlHelpWindow();

    wxHtmlHelpData* GetData() { return m_Data; }
    wxHtmlHelpController* GetController() const { return m_helpController; }
    void SetController( wxHtmlHelpController* controller );
    bool Display( const wxString& x );
    bool Display( const int id );
    bool DisplayContents();
    bool DisplayIndex();
    bool KeywordSearch( const wxString& keyword,wxHelpSearchMode mode = wxHELP_SEARCH_ALL );

    void UseConfig( wxConfigBase *config, const wxString& rootpath = wxEmptyString ) {
      m_Config = config;
      m_ConfigRoot = rootpath;
      ReadCustomization( config, rootpath );
    }
    void ReadCustomization( wxConfigBase *cfg, const wxString& path = wxEmptyString );
    void WriteCustomization( wxConfigBase *cfg, const wxString& path = wxEmptyString );
    void NotifyPageChanged();
    void RefreshLists();
    wxHtmlWindow* GetHtmlWindow() const { return m_HtmlWin; }
    wxSplitterWindow* GetSplitterWindow() const { return m_Splitter; }
    wxToolBar* GetToolBar() const { return m_toolBar; }
    wxHtmlHelpFrameCfg& GetCfgData() { return m_Cfg; }
    wxTreeCtrl *GetTreeCtrl() const { return m_ContentsBox; }

  protected:
    void Init( wxHtmlHelpData* data = NULL );

    // Adds items to m_Contents tree control
    void CreateContents();

    // Adds items to m_IndexList
    void CreateIndex();

    // Add books to search choice panel
    void CreateSearch();

    // Updates "merged index" structure that combines indexes of all books
    // into better searchable structure
    void UpdateMergedIndex();

    // Add custom buttons to toolbar
    virtual void AddToolbarButtons( wxToolBar *toolBar, int style );

    // Displays options dialog (fonts etc.)
    virtual void OptionsDialog();

    void OnToolbar( wxCommandEvent& event );
    void OnContentsSel( wxTreeEvent& event );
    void OnIndexSel( wxCommandEvent& event );
    void OnIndexFind( wxCommandEvent& event );
    void OnIndexAll( wxCommandEvent& event );
    void OnSearchSel( wxCommandEvent& event );
    void OnSearch( wxCommandEvent& event );
    void OnBookmarksSel( wxCommandEvent& event );
    void OnSize( wxSizeEvent& event );

    // Images:
    enum {
      IMG_Book = 0,
      IMG_Folder,
      IMG_Page
    };

  protected:
    wxHtmlHelpData* m_Data;
    bool m_DataCreated;  // m_Data created by frame, or supplied?
    wxString m_TitleFormat;  // title of the help frame
    // below are various pointers to GUI components
    wxHtmlWindow *m_HtmlWin;
    wxSplitterWindow *m_Splitter;
    wxPanel *m_NavigPan;
    wxNotebook *m_NavigNotebook;
    wxTreeCtrl *m_ContentsBox;
    wxTextCtrl *m_IndexText;
    wxButton *m_IndexButton;
    wxButton *m_IndexButtonAll;
    wxListBox *m_IndexList;
    wxTextCtrl *m_SearchText;
    wxButton *m_SearchButton;
    wxListBox *m_SearchList;
    wxChoice *m_SearchChoice;
    wxStaticText *m_IndexCountInfo;
    wxCheckBox *m_SearchCaseSensitive;
    wxCheckBox *m_SearchWholeWords;
    wxToolBar*  m_toolBar;

    wxComboBox *m_Bookmarks;
    wxArrayString m_BookmarksNames, m_BookmarksPages;

    wxHtmlHelpFrameCfg m_Cfg;

    wxConfigBase *m_Config;
    wxString m_ConfigRoot;

    // pagenumbers of controls in notebook (usually 0,1,2)
    int m_ContentsPage;
    int m_IndexPage;
    int m_SearchPage;

    // lists of available fonts (used in options dialog)
    wxArrayString *m_NormalFonts, *m_FixedFonts;
    int m_FontSize; // 0,1,2 = small,medium,big
    wxString m_NormalFace, m_FixedFace;

    bool m_UpdateContents;
    wxHtmlEasyPrinting *m_Printer;
    wxHashTable *m_PagesHash;
    wxHtmlHelpController* m_helpController;

    int m_hfStyle;

  private:
    void DoIndexFind();
    void DoIndexAll();
    void DisplayIndexItem( const wxHtmlHelpMergedIndexItem *it );
    wxHtmlHelpMergedIndex *m_mergedIndex;

    DECLARE_EVENT_TABLE()
    DECLARE_NO_COPY_CLASS( wxHtmlHelpWindow )
};

/*!
  Command IDs
*/

enum {
  //wxID_HTML_HELPFRAME = wxID_HIGHEST + 1,
  wxID_HTML_PANEL = wxID_HIGHEST + 2,
  wxID_HTML_BACK,
  wxID_HTML_FORWARD,
  wxID_HTML_UPNODE,
  wxID_HTML_UP,
  wxID_HTML_DOWN,
  wxID_HTML_PRINT,
  wxID_HTML_OPENFILE,
  wxID_HTML_OPTIONS,
  wxID_HTML_BOOKMARKSLIST,
  wxID_HTML_BOOKMARKSADD,
  wxID_HTML_BOOKMARKSREMOVE,
  wxID_HTML_TREECTRL,
  wxID_HTML_INDEXPAGE,
  wxID_HTML_INDEXLIST,
  wxID_HTML_INDEXTEXT,
  wxID_HTML_INDEXBUTTON,
  wxID_HTML_INDEXBUTTONALL,
  wxID_HTML_NOTEBOOK,
  wxID_HTML_SEARCHPAGE,
  wxID_HTML_SEARCHTEXT,
  wxID_HTML_SEARCHLIST,
  wxID_HTML_SEARCHBUTTON,
  wxID_HTML_SEARCHCHOICE,
  wxID_HTML_COUNTINFO
};

#endif // wxUSE_WXHTML_HELP

#endif
